MarkLogic Server 11.0 Product Documentation

PUT /manage/v2/databases/{id|name}/rebalancer

Summary

Update the rebalancer configuration for a database.

Response

Upon success, MarkLogic Server returns status code 204 (No Content).

Required Privileges

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

You can modify the following configuration settings:

• rebalancer-enable: Set to true or false to enable or disable the rebalancer on this database. For details, see admin:database-set-rebalancer-enable.
• rebalancer-throttle: Set the rebalancer throttle to control the priority of performing rebalancing on the database. Higher numbers give rebalancing a higher priority and system resource allocation. For details, see admin:database-set-rebalancer-throttle.

You can include one or more properties in the input configuration. Properties not included are unchanged. For details, see Database Rebalancing in the Administrator's Guide.

The structure of the data in the request body is as follows:

rebalancer-enable

Enable automatic rebalancing after configuration changes.

rebalancer-throttle

Larger numbers mean work harder at rebalancing.

Example

$ cat reb-config.xml
==> 
<database-rebalancer-properties xmlns="http://marklogic.com/manage" 
  <rebalancer-enable>true</rebalancer-enable>
  <rebalancer-throttle>5</rebalancer-throttle>
</database-rebalancer-properties>

$ cat reb-config.json
==> 
{ 
  "rebalancer-enable":true, 
  "rebalancer-throttle":5
}

$ curl --anyauth --user user:password -X PUT -d @./reb-config.xml \
    -i -H "Accept: application/xml" \
    http://localhost:8002/manage/v2/databases/example-db/rebalancer

==> The rebalancer configuration is modified. MarkLogic Server returns
    status code 204 (No Content) and headers similar to the following:

HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive